home *** CD-ROM | disk | FTP | other *** search
/ Saar AMOK 2 / Saar AMOK II - Oktober 1994 (1994)(Kreativ Marketing)(DE)[!][I-7598].iso / tools / amigaguide / ag_v39 / sample.guide (.txt) < prev   
Amigaguide Document  |  1992-12-29  |  4KB  |  71 lines

  1. @database Sample.guide
  2. @author "David N. Junod"
  3. @(c) "Copyright 
  4.  1992 Commodore-Amiga, Inc."
  5. @$VER: Sample.guide 39.1 (11/04/92)
  6. @font helvetica.font 15
  7. @wordwrap
  8. @node Main "Sample AmigaGuide document"
  9. The following list shows the commands that can be used in @{b}AmigaGuide@{ub}.  The @{fg highlight}highlighted@{fg text} commands are new for the 3.0 version of @{b}AmigaGuide@{ub}.
  10. @{b} @database <name> @{ub}
  11. This command must always be the very first line of the @{b}AmigaGuide@{ub} database.
  12. @{b}@{fg highlight} @author <name> @{ub}@{fg text}
  13. Specify the author of the database.
  14. @{b}@{fg highlight} @(c) <copyright> @{ub}@{fg text}
  15. The copyright notice for the database.
  16. @{b}@{fg highlight} @$VER: <AmigaDOS version string> @{ub}@{fg text}
  17. Used to specify the version of the database.  This command must always be in upper-case.
  18. @{b} @master <name> @{ub}
  19. Used to specify the source file for the database.
  20. @{b}@{fg highlight} @font <name> <size> @{ub}@{fg text}
  21. Specify the font to use for a database.
  22. @{b} @index <name/node> @{ub}
  23. Specify the name of the index node, accessed by the @{"  Index  " beep 0} button.  Can be a node in an external database.
  24. @{b} @help <name/node> @{ub}
  25. Specify the name of the help node, accessed by the @{"  Help  " beep 0} button or the help key on the keyboard.  Can be a node in an external database.
  26. @{b}@{fg highlight} @wordwrap @{ub}@{fg text}
  27. Turn wordwrap on for the database.
  28. @{b} @node <name> [title] @{ub}
  29. Start a node.
  30. @{b} @dnode <name> [title] @{ub}
  31. Start a dynamic node.  The dynamic node hosts are queried for the node data.
  32. @{b} @remark <remark> @{ub}
  33. Remark (not displayed to the user).
  34. The following commands can be used within a node.
  35. @{b} @title <title> @{ub}
  36. The title for the node.
  37. @{b} @toc <name> @{ub}
  38. Specify the name of the Contents node for this node.  Can be a node in an external database.
  39. @{b} @prev <name> @{ub}
  40. Specify the name of node to go to when the @{" Browse < " beep 0} button is pressed.
  41. @{b} @next <name> @{ub}
  42. Specify the name of node to go to when the @{" Browse > " beep 0}  button is pressed.
  43. @{b}@{fg highlight} @keywords <keywords> @{ub}@{fg text}
  44. Keywords assigned to a node.  Used when searching for a node.
  45. @{b}@{fg highlight} @font <name> <size> @{ub}@{fg text}
  46. Specify the font to use within the node.
  47. @{b} \@{<label> <command>} @{ub}
  48. Indicate a textual link point.  Can be anywhere in a line.  This is displayed as a button within the text.
  49. Starting with 3.0 @{b}AmigaGuide@{ub}, buttons can also link to graphics, sounds and other datatypes.  See @{"Amiga" link amiga.brush/main}.
  50. @{b} @endnode @{ub}
  51. End a node.
  52. The following list of attributes can be applied to the text.  This feature is only supported with the 3.0 version of @{b}AmigaGuide@{ub}.
  53.  \@{b}        Turns @{b}bold@{ub} on.
  54.  \@{ub}        Turns @{b}bold@{ub} off.
  55.  \@{i}        Turns @{i}italic@{ui} on.
  56.  \@{ui}        Turns @{i}italic@{ui} off.
  57.  \@{u}        Turns @{u}underline@{uu} on.
  58.  \@{uu}        Turns @{u}underline@{uu} off.
  59. The foreground, or text, color can be changed using the \@{fg <color>} command.  The background color can be changed using the \@{bg <color>} command.  <color> can be:
  60.   @{fg text}text@{fg text}
  61.   @{fg shine}shine@{fg text}
  62.   @{fg shadow}shadow@{fg text}
  63.   @{fg fill}fill@{fg text}
  64.   @{fg filltext}filltext@{fg text}
  65.   @{fg back}@{bg text}background@{fg text}@{bg back}
  66.   @{fg highlight}highlight@{fg text}
  67. Commands can be displayed as normal text, by preceeding the @ sign with a backslash.  For example:
  68.   \\@{"Fake" link Main}
  69. would show up as normal text within the database.
  70. @endnode
  71.